home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / msdos / viewers / gifkit11 / gifls.doc < prev    next >
Text File  |  1990-02-22  |  7KB  |  167 lines
  1. GIFLS
  2.   version 1.2, portable
  3.   11/16/89
  4.   by James W. Birdsall
  5.  
  6.   GIF and "Graphic Interchange Format" are trademarks (tm) of
  7.   CompuServe, Inc., an H&R Block company.
  8.  
  9.  
  10.   This program vaguely resembles the Unix utility ls, in that it
  11.   provides a listing of GIF files and some pertinent information
  12.   about them. The format is also after ls.
  13.  
  14.   Usage: gifls [-chlswf] [target] [target target...]
  15.     If no target is given, GIFLS will scan the current directory.
  16.   Valid targets are directory names, filenames (including paths), or
  17.   filenames (including paths) with wildcards. Target types may be
  18.   mixed. For example, if there is a directory \GIF which contains
  19.   files ALBERT.GIF, ALIEN.GIF, and BORA.GIF, then
  20.      GIFLS \gif                  will list all of them.
  21.      GIFLS \gif\albert.gif       will list ALBERT
  22.      GIFLS \gif\a*.*             will list ALBERT and ALIEN
  23.      GIFLS \gif\*r*              will list ALBERT and BORA
  24.  
  25.  
  26.   The options are as follows:
  27.  
  28.      -c[l|g]nnn   where l = less than
  29.                         g = greater than
  30.                         nnn = number
  31.           causes a selective search based on number of colors in the
  32.           GIF file. If neither l nor g is specified, GIFLS searches
  33.           for files with exactly nnn colors.
  34.  
  35.      -h[l|g]nnn    as above
  36.           causes a selective search based on the height of the image
  37.  
  38.      -l
  39.           causes a complete analysis of each file (subject to above
  40.           searches)
  41.  
  42.      -s
  43.           prints a line for every file, including non-GIF files
  44.  
  45.      -w[l|g]nnn    as above
  46.           causes a selective search based on the width of the image
  47.  
  48.      -f
  49.           used for front end for GIFSTRIP and GIFCOLOR. Prints out a list
  50.           of filenames (according to any specified searches) on stdout.
  51.           Discards rest of output. Ignores -l and -s flags.
  52.  
  53.  
  54.  
  55.   Any option may be combined with any other option. However, if more
  56.   than one of the same kind of search is used, then only the last one
  57.   of that kind on the line will have any effect.
  58.  
  59.  
  60.  
  61.  
  62. WHAT THE OUTPUT MEANS:
  63.  
  64.      WITHOUT the -l option:
  65.  
  66.            G    30208  320 x  200 @ 256 \temp\YAR.GIF
  67.  
  68.       "G" means that the file has a global color map (blank if none).
  69.       The next columns are the size (in bytes) of the file, the
  70.       width and height of the screen raster (in pixels), and the
  71.       number of colors in the image based on the number of bits per
  72.       pixel (which, according to strict interpretation of the GIF
  73.       specs, is wrong, but the field which is supposed to tell how
  74.       many colors is usually set to a random number in most files!).
  75.       The last column is the filename, including path.
  76.  
  77.  
  78.      WITH the -l option: (three lines of output in this example)
  79.  
  80.          G-   30208  320 x  200 @ 256 C4 P8 B0   \temp\YAR.GIF
  81.                GS    29215BY   115BL C8  320 x  200 @ 256    0L    0T
  82.                GIF terminator and extra characters
  83.                ----------
  84.  
  85.       LINE 1:
  86.          G-   30208  320 x  200 @ 256 C4 P8 B0   \temp\YAR.GIF
  87.  
  88.       "G" means that the file has a global color map (blank if none).
  89.       "-" means that bit 3 of byte 5 of the screen descriptor is set
  90.       correctly (to 0); otherwise "B" is displayed.
  91.       The next columns are the size (in bytes) of the file, the
  92.       width and height of the screen raster (in pixels), and the
  93.       number of colors in the image based on the number of bits per
  94.       pixel (which, according to strict interpretation of the GIF
  95.       specs, is wrong, but the field which is supposed to tell how
  96.       many colors is usually set to a random number in most files!).
  97.       The next column "C4" means that there are (supposedly) four
  98.       bits of color data per pixel (this is the field that is set
  99.       randomly in most files), where "C" stands for "Color bits."
  100.       "P8" means that there are eight bits per pixel, where "P"
  101.       stands of "Pixel bits." "B0" means that the background color
  102.       is color index 0 in the applicable color map, where "B" stands
  103.       for "Background." The last column is the filename, with path.
  104.  
  105.       The following lines indicate data about each individual image
  106.       and/or extension block found in the GIF file. While most files
  107.       only contain one image and no extension blocks, the GIF spec
  108.       provides for multiple images and extension blocks within one
  109.       file. The example file contains only one image and no extension
  110.       blocks.
  111.  
  112.  
  113.       LINE 2:
  114.                GS    29215BY   115BL C8  320 x  200 @ 256    0L    0T
  115.  
  116.       The "G" means that this image uses the global color map instead
  117.       of a local color map ("L"). "S" means that the image is stored
  118.       sequentially instead of in interlaced format ("I"). The next
  119.       two columns are the number of bytes ("BY") in the compressed
  120.       image, and the number of blocks ("BL") these bytes are
  121.       formatted in. "C8" means that there are eight bits of color
  122.       data per pixel in this image, where "C" stands for "Color
  123.       bits." The next columns are the width and height of the image
  124.       (in pixels), which is usually but not always the same as the
  125.       screen raster, and the colors in the image (based on the bit
  126.       count). The last two columns are the coordinates of the upper
  127.       left corner of the image within the screen raster, where "L"
  128.       is the horizontal coordinate (stands for Left side) and "T" is
  129.       the vertical coordinate (stands for Top), and where all
  130.       coordinates are in pixels measured from an origin at the top
  131.       left corner of the screen raster.
  132.  
  133.       The format of an extension block is as follows:
  134.                Extension: func nnn  xxxxxxxxBY yyyyyBL
  135.       where nnn is the function number, x the number of bytes in the
  136.       extension block, and y the number of blocks within it.
  137.  
  138.       LINE 3:
  139.       The final (informative) line of the output is always either
  140.                GIF terminator and nnn extra characters
  141.       or
  142.                GIF terminator
  143.       The first means that the file has probably been transferred
  144.       using a protocol such as XMODEM, which leaves spurious
  145.       characters on the end of the file. It means just that; that
  146.       there are spurious characters in the file after the GIF
  147.       terminator character. The second means that the GIF terminator
  148.       character is the last character in the file, which is good.
  149.  
  150.       And the last line is always:
  151.                ----------
  152.  
  153.       So, for this example, the whole thing looks like:
  154.          G-   30208  320 x  200 @ 256 C4 P8 B0   \temp\YAR.GIF
  155.                GS    29215BY   115BL C8  320 x  200 @ 256    0L    0T
  156.                GIF terminator and extra characters
  157.                ----------
  158.  
  159.  
  160.  
  161.    GIFLS can be used as a front end for GIFSTRIP and GIFCOLOR. When the -f
  162. option is used, GIFLS prints out a list of filenames according to any searches
  163. (-w, -h, -c) specified on the command line. This list can be piped in to
  164. GIFSTRIP or GIFCOLOR. When these programs detect that their stdin has been
  165. redirected, they parse their command lines for options and then read targets
  166. from stdin ONLY. 
  167.